Repository navigation
docs: Professionally restructure project README - #22
Merged
Merged
Conversation
m4sh-wacker
force-pushed
the
docs/restructure-readme
branch
from
November 21, 2026 09:47
6738f99 to
53ca7a9
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Shortens the README to an overview of detection, recipes, and CTF search. The navigation row sits above the existing showcase video. Development covers the Node.js requirement and npm commands. Standalone Edition explains offline use, main-thread processing, and when to download a fresh copy.
The privacy section explains what a shared recipe contains and when a link includes input. Contributor guidance includes a collapsible source layout. Project Lead and License each have their own section.
Verification
main. OnlyREADME.mdchanged.